home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / tlx_hype.zip / HYPE.DOC < prev    next >
Text File  |  1988-10-30  |  7KB  |  195 lines
  1.              HYPE - A simple Hypertext system for the PC
  2.  
  3.  
  4. HYPE is a simple hypertext demonstration for the IBM PC. It is
  5. useful for on-line documentation, CAI etc., It is provided with
  6. full source code to encourage experimentation.
  7.  
  8. Startup
  9.  
  10. 1. Boot the system.
  11. 2. Insert the disk containing HYPE.COM in Drive A:
  12. 3. If the DOS prompt is not A>, type A: and press the ENTER key to switch
  13.    to drive A:.
  14. 4. Type HYPE filename and press RETURN. "filename" is the name of
  15.    file containing the marked text. For example, "HYPE poker.hyp"
  16.    will display the sample file which was supplied with HYPE.
  17. 5. HYPE will display its opening screen and wait for you to press
  18.    a key.
  19. 6. HYPE will display the text file one page at a time.  Concepts
  20.    which have threaded text associated with them are displayed in
  21.    reverse video. One threaded concept will be diaplayed with a
  22.    special cursor called the button. On a color display the button
  23.    is yellow text on a black background. On a mono screen the text
  24.    under the button is underlined. You can move through the text
  25.    with the following commands:
  26.  
  27.      ->      - right arrow - move to next highlighted area
  28.      <-      - left arrow - move back to previous highlighted
  29.                             area
  30.      Esc     - exit the current window and return to the one
  31.                below it. If the window is the main window (the
  32.                large one which is opened at the beginning of the
  33.                program) the program is terminated and control is
  34.                returned to DOS.
  35.      PgUp    - display the next page of text.
  36.      PgDn    - display the previous page
  37.      Enter   - display the text threaded to the concept under
  38.                the button.
  39.      F10     - quit the program and return to DOS
  40.  
  41.  
  42. HYPE files
  43.  
  44. Text files for HYPE should be ASCII files which contain no
  45. control characters. The file is threaded using embedded marks and
  46. control commands.
  47.  
  48.  
  49. Embedded marks
  50.  
  51. Text is marked by surrounding text strings with "\" characters.
  52. Text surrounded by "\" 's is displayed on the screen in reverse
  53. video. Marks may not extend beyond the end of a line. Embedded
  54. blanks within marked text are significant. Marks are not case
  55. sensitive, thus \expert system\ is equivalent to \Expert System\,
  56. but no \expert    system\. The "\" characters will not be
  57. displayed on the screen.
  58.  
  59.  
  60. Control commands
  61.  
  62. HYPE commands lines begin with ".." starting in column one. The
  63. following commands are available:
  64.  
  65. ..label          - labels text. If the <Enter> key is pressed
  66.            with button over "label" the file will be
  67.            searched until a line beginning with ..label is
  68.            found.
  69.  
  70. ..end(label)     - end of text associated with "label". When
  71.            <Enter> pressed with the button on "label",
  72.            text between ..label and ..end(label) will be
  73.            displayed. Labeled blocks of text may be
  74.            nested or overlap. If ..end(label) cannot be
  75.            found HYPE will read to the end of the file.
  76.            The first block processed has the default
  77.            label, "main". If ..main and ..end(main)
  78.            cannot be found, it will be possible to read
  79.            the entire file sequentially. Blocks of text
  80.            may have more than one label, but each lable
  81.            should have its own end statement.
  82.  
  83. ..file(label) filename
  84.          - associates the file, filename with "label".
  85.            The file is read and its text, up to
  86.            ..end(label), is displayed along with any text
  87.            in the current file. "file" commands may be
  88.            nested, but no more than 15 files may be open
  89.            at once. If you want to use more files, it
  90.            will be necessary to recompile the program.
  91.  
  92. ..window(label) text_color,back_color,org_x,org_y,size_x,size_y
  93.         - set parameters for the window displaying the
  94.           text associated with "label". All parameters
  95.           are integers. This command is optional. If it
  96.           is not included, default values will be used
  97.           for the window parameters. The parameters are:
  98.       text_color - color of displayed text
  99.       back_color - background color. Legal values for color are:
  100.                0  - black             8  - dark gray
  101.                1  - blue              9  - light blue
  102.                2  - green             10 - light green
  103.                3  - cyan              11 - light cyan
  104.                4  - red               12 - light red
  105.                5  - magenta           13 - light magenta
  106.                6  - brown             14 - yellow
  107.                7  - light gray        15 - white
  108.            On most monochrome monitors blue text is
  109.            displayed as underlined text.
  110.       org_x,
  111.       org_y      - The upper left hand corner of the window. The
  112.             upper left of the screen is location 1,1.
  113.             org_x,org_y is the first position in which
  114.             text may be written. The frame ins not part
  115.             of the window. The upper left corner of the
  116.             frame is at location org_x-1,org_y-1.
  117.       size_x,
  118.       size_y      - The number of colums and rows in the window.
  119.  
  120.       You may change some window parameters and accept defualts
  121.       for others by not including values for parameters in the
  122.       parameter list. For example,
  123.  
  124.        ..window(expert systems) 4,15,,,45,10
  125.  
  126.       accepts the default origin for the window, but will produce
  127.       red text on a white background in a 45 column by 10 row
  128.       window.
  129.  
  130. Example text file
  131.  
  132. ..main
  133. The object of the game of poker is to win the
  134. pot.   The pot is made up of all \bets\ made by
  135. all players in any one deal.   Each bet means
  136. that the player thinks or hopes he or she has
  137. the \best hand\.   When every player has bet as
  138. much as he or she wants to,  the players show
  139. their hands and the best hand wins the pot.
  140. ..end(main)
  141.  
  142. ..best hand
  143. Here is a list of the rank of poker hands :
  144.   straight flush
  145.   four of a kind
  146.   \full house\
  147.   \flush\
  148.   straight
  149.   three of a kind
  150.   two pairs
  151.   one pair
  152.   highest card
  153. ..end(best hand)
  154.  
  155. ..flush
  156. When  a  hand contains all cards of the  same
  157. suit,  it's called a flush. A straight flush
  158. is when all of the cards are in sequence.  In
  159. a  five card poker hand a royal flush is when
  160. one  hand contains the A,K,Q,J and 10 of  one
  161. suit.
  162. ..end(flush)
  163.  
  164. ..full house
  165. ..window(full house) 4,15
  166. A  full house is three cards of one rank  and
  167. two cards of another rank, such as 4-4-4-9-9.
  168. ..end(full house)
  169.  
  170. ..bets
  171. How betting works.
  172. Before the cards are dealt,  some poker games
  173. may  require each player to place an  initial
  174. amount in the pot. This is called the "ante".
  175. A betting interval begins when a player  bets
  176. one  or  more chips.  Players after that  can
  177. either "call" , "raise" or "fold".
  178. ..end(bets)
  179.  
  180.  
  181.  
  182. Good   luck  with HYPE.   We would be very interested in  hearing   of
  183. your  experiments,   enhancements or even (gasp) bugs that you may  find.
  184. Please write to us with your comments or questions.
  185.  
  186.      Bill and Bev Thompson
  187.      C/O AI Expert Magazine
  188.      500 Howard St.
  189.      San Francisco, CA 94105
  190.  
  191. or  on  the AI Expert BBS on Compuserv.  Our id is BillandBev Thompson,
  192. [76703,4324]. You can also contact us on BIX, our id is bbt.
  193.  
  194.    Bill and Bev Thompson
  195.